transport: implement `graphql-transport-ws` ws sub-protocol #1507

jordanabderrachid · 2021-04-04T12:24:04Z

This implements the graphql-transport-ws websocket sub-protocol.

I have refactored the sub-protocol message parsing by creating a generic message message and a messageExchanger interface defined in the file websocket_subprotocol.go.

The previously supported graphql-ws sub-protocol is implemented in the file websocket_graphqlws.go. The new protocol is implemented in the websocket_graphql_transport_ws.go.

I've aimed to keep this change as much backward compatible as possible, the default sub-protocol selected is graphql-ws, even if the ws client does not explicitly request it. I am also not requiring the consumer of the Transport struct to provide the list of supported sub-protocols, and they are injected at runtime instead.

In addition to that, I have fixed some libraries version mismatch in the example/chat example project. I have included another implementation of the websocket link that uses the newly supported sub-protocol.

Closes #1430

I have:

Added tests covering the bug / feature (see testing)
Updated any relevant documentation (see docs)

coveralls · 2021-04-04T12:25:43Z

Coverage increased (+0.06%) to 67.362% when pulling 07191a6 on jordanabderrachid:subscription-protocol into 28caa6c on 99designs:master.

jordanabderrachid · 2021-04-06T15:47:42Z

It looks like the integration tests failed because of an issue with the docker registry.

 /usr/bin/docker pull golang:1.13-alpine
  Error response from daemon: Head https://registry-1.docker.io/v2/library/golang/manifests/1.13-alpine: EOF
  Warning: Docker pull failed with exit code 1, back off 6.665 seconds before retry.
  /usr/bin/docker pull golang:1.13-alpine
  Error response from daemon: Get https://registry-1.docker.io/v2/: EOF
  Warning: Docker pull failed with exit code 1, back off 2.261 seconds before retry.
  /usr/bin/docker pull golang:1.13-alpine
  Error response from daemon: Get https://registry-1.docker.io/v2/: EOF
  Error: Docker pull failed with exit code 1

Is there a way to run the tests again?

MichaelJCompton · 2021-04-12T04:14:19Z

Thanks for the PR - ran tests again for you.

audiolion · 2021-05-24T21:51:53Z

Would be great to have this!

zdraganov · 2021-08-02T12:14:16Z

Starting from your PR, I've extended it and adding duplex ping pong option here #1578

xiehuc · 2021-08-11T11:45:35Z

this would be awesome

vitorfalcaor · 2021-10-09T04:01:24Z

Hello, any chance this will get merged, please?

jaredly

@StevenACoffman asked me to take a look at this, and it makes sense to me! I don't have much experience with graphql subscriptions though, so take it with a grain of salt. It would be nice to have an integration test that actually fired up a server and verified that the nodejs graphql-ws library can talk to it, but the included example is probably the next best thing.

example/chat/readme.md

jaredly · 2021-10-13T15:22:53Z

graphql/handler/transport/websocket.go

@@ -86,17 +86,21 @@ func (t Websocket) Do(w http.ResponseWriter, r *http.Request, exec graphql.Graph
 }

 func (c *wsConnection) init() bool {
-	message := c.readOp()
-	if message == nil {
+	m, err := c.me.NextMessage()


I don't love single-character variable names

jaredly · 2021-10-13T15:24:18Z

graphql/handler/transport/websocket.go

 	c.mu.Lock()
-	c.conn.WriteJSON(msg)
+	// TODO: missing error handling here, err from previous implementation


could you make a ticket for this error handling, and then do TODO(#1234) with the issue number?

jaredly · 2021-10-13T15:24:56Z

graphql/handler/transport/websocket.go

@@ -152,26 +158,27 @@ func (c *wsConnection) run() {

 	for {
 		start := graphql.Now()
-		message := c.readOp()
-		if message == nil {
+		m, err := c.me.NextMessage()


nit: variable naming

jaredly · 2021-10-13T15:27:24Z

graphql/handler/transport/websocket_subprotocol.go

+	var text string
+	switch t {
+	default:
+		text = "unknown"


nit: imo these would read better as returns

jaredly · 2021-10-13T15:30:54Z

graphql/handler/transport/websocket_test.go

+		handler.SendNextSubscriptionMessage()
+		msg = readOp(c)


could you add a comment here about why we expect the subscription message to be received twice?

StevenACoffman · 2021-10-13T15:48:50Z

@jordanabderrachid if you can address the review from jared above and resolve the conflicts, we can get this merged! Thanks!

frederikhors · 2021-11-05T14:25:15Z

@jordanabderrachid are you still there?

StevenACoffman · 2021-11-05T15:32:50Z

@frederikhors It's been long enough that if you (or anyone) want to fork from the good work of @jordanabderrachid and make a new PR, he'll still get his credit for his original commits.

Co-authored-by: Jared Forsyth <jabapyth@gmail.com> Signed-off-by: Steve Coffman <steve@khanacademy.org>

StevenACoffman · 2021-11-09T22:10:57Z

@zdraganov I rebased but I would appreciate it if in your PR you could take care of adding a comment as mentioned above describing why we expect the subscription message to be received twice. Thanks!

enisdenjo mentioned this pull request May 24, 2021

Getting WebSocket connection to 'ws://localhost:7080/query' failed on connecting graphql-ws client with gqlgen golang server enisdenjo/graphql-ws#185

Closed

zdraganov mentioned this pull request Aug 2, 2021

Add support for graphql-transport-ws with duplex ping-pong #1578

Merged

mtibben added the websocket label Sep 6, 2021

jaredly approved these changes Oct 13, 2021

View reviewed changes

StevenACoffman added the awaiting response label Oct 13, 2021

jordanabderrachid and others added 11 commits November 9, 2021 16:49

websocket: create messageExchanger to handle subprotocol messages

64da2cb

remove unused type

212e103

typo in comments

f0589ac

change graphqlwsMessageType type to string

2551470

add support for graphql-transport-ws subprotocol

9e0fb06

fix chat app example

6bc8f31

update example chat app dependencies

51f1fa2

improve chat app exmaple to use the recommended ws library

ff0985b

add tests

fad4059

removed unused const in tests

1606046

Update example/chat/readme.md

07191a6

Co-authored-by: Jared Forsyth <jabapyth@gmail.com> Signed-off-by: Steve Coffman <steve@khanacademy.org>

StevenACoffman force-pushed the subscription-protocol branch from c322e11 to 07191a6 Compare November 9, 2021 22:03

StevenACoffman merged commit 828820a into 99designs:master Nov 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

transport: implement `graphql-transport-ws` ws sub-protocol #1507

transport: implement `graphql-transport-ws` ws sub-protocol #1507

jordanabderrachid commented Apr 4, 2021

coveralls commented Apr 4, 2021 •

edited

Loading

jordanabderrachid commented Apr 6, 2021

MichaelJCompton commented Apr 12, 2021

audiolion commented May 24, 2021

zdraganov commented Aug 2, 2021 •

edited

Loading

xiehuc commented Aug 11, 2021

vitorfalcaor commented Oct 9, 2021

jaredly left a comment

jaredly Oct 13, 2021

jaredly Oct 13, 2021

jaredly Oct 13, 2021

jaredly Oct 13, 2021

jaredly Oct 13, 2021

StevenACoffman commented Oct 13, 2021

frederikhors commented Nov 5, 2021

StevenACoffman commented Nov 5, 2021

StevenACoffman commented Nov 9, 2021

transport: implement graphql-transport-ws ws sub-protocol #1507

transport: implement graphql-transport-ws ws sub-protocol #1507

Conversation

jordanabderrachid commented Apr 4, 2021

coveralls commented Apr 4, 2021 • edited Loading

jordanabderrachid commented Apr 6, 2021

MichaelJCompton commented Apr 12, 2021

audiolion commented May 24, 2021

zdraganov commented Aug 2, 2021 • edited Loading

xiehuc commented Aug 11, 2021

vitorfalcaor commented Oct 9, 2021

jaredly left a comment

Choose a reason for hiding this comment

jaredly Oct 13, 2021

Choose a reason for hiding this comment

jaredly Oct 13, 2021

Choose a reason for hiding this comment

jaredly Oct 13, 2021

Choose a reason for hiding this comment

jaredly Oct 13, 2021

Choose a reason for hiding this comment

jaredly Oct 13, 2021

Choose a reason for hiding this comment

StevenACoffman commented Oct 13, 2021

frederikhors commented Nov 5, 2021

StevenACoffman commented Nov 5, 2021

StevenACoffman commented Nov 9, 2021

transport: implement `graphql-transport-ws` ws sub-protocol #1507

transport: implement `graphql-transport-ws` ws sub-protocol #1507

coveralls commented Apr 4, 2021 •

edited

Loading

zdraganov commented Aug 2, 2021 •

edited

Loading